groundsdk 7.7.2 API/com.parrot.drone.groundsdk.device.peripheral/Microhard

Microhard

interface Microhard : Peripheral

Microhard peripheral for remote controls.

Allows to pair devices using Microhard technology

This peripheral can be obtained from a RemoteControl using: rc.getPeripheral(Microhard::class.java)

Types

Link copied to clipboard
enum Bandwidth : Enum<Microhard.Bandwidth>

Operation bandwidth.

Link copied to clipboard
data class ConnectionParameters(val channel: Int, val power: Int, val bandwidth: Microhard.Bandwidth)

Device connection parameters.

Link copied to clipboard
Link copied to clipboard
enum Model : Enum<Microhard.Model>

Microhard chip model.

Link copied to clipboard
data class PairingParameters(    val channel: Int,     val power: Int,     val bandwidth: Microhard.Bandwidth,     val encryptionAlgorithm: Microhard.EncryptionAlgorithm)

Device pairing parameters.

Link copied to clipboard
sealed class PairingStatus

Device pairing operation outcome.

Link copied to clipboard
sealed class State

Operation state.

Properties

Link copied to clipboard
abstract val model: Microhard.Model?

Microhard model; null if unknown or unrecognized.

Link copied to clipboard
abstract val pairingStatus: Microhard.PairingStatus?

Pairing operation status.

Link copied to clipboard
abstract val state: Microhard.State

Current state.

Link copied to clipboard
abstract val supportedBandwidths: Set<Microhard.Bandwidth>

Supported operation bandwidths.

Link copied to clipboard
abstract val supportedChannels: IntegerRange

Supported operation channels.

Link copied to clipboard
abstract val supportedEncryptionAlgorithms: Set<Microhard.EncryptionAlgorithm>

Supported encryption algorithms.

Link copied to clipboard
abstract val supportedPowers: IntegerRange

Supported operation power, in dBm.

Functions

Link copied to clipboard
abstract fun pairDevice(    networkId: String,     encryptionKey: String,     pairingParameters: Microhard.PairingParameters,     connectionParameters: Microhard.ConnectionParameters): Boolean

Pairs with a remote device

Link copied to clipboard
abstract fun powerOn(): Boolean

Powers on Microhard chip.

Link copied to clipboard
abstract fun shutDown(): Boolean

Shuts down Microhard chip.